home *** CD-ROM | disk | FTP | other *** search
/ Scene Storm / Scene Storm - Volume 1.iso / coding / c / changedir / ccd.doc < prev    next >
Text File  |  1995-11-05  |  10KB  |  296 lines
  1.  
  2.                         CCD - Cedric's CD utility
  3.                            $Revision: 1.2 $
  4.                                ccd v3.2
  5.  
  6.  
  7.                                              Cedric BEUST
  8.                                              "Les Ducs de Savoie"
  9.                                              1, rue Roger Martin du Gard
  10.                                              06000 NICE
  11.                                              FRANCE
  12.  
  13.                                              email: beust@sophia.inria.fr
  14.  
  15.  
  16.       WHAT IS CCD?
  17.       ------------
  18.  
  19.   ccd is an attempt to have the equivalent to M*-DOS ncd (Norton's cd).
  20. This smart utility is most precious for hard disk users: it allows to cd
  21. to a directory without having to specify the whole path.
  22.  
  23.   For example, if you have a directory dh0:dp/matt/netdcc, just issue the
  24. command
  25.  
  26.        (0).3:51PM> ccd netdcc
  27.  
  28. and there you are!
  29.  
  30. In this documentation, lines preceded by a version number (e.g. (v3.1))
  31. indicate the version where this feature appeared.
  32.  
  33.  
  34.       LEGAL STUFF
  35.       -----------
  36.  
  37.   Why bother? Nobody ever reads it, anyway...
  38.  
  39.   Okay, this program is *not* in public domain. It is freeware, and I hold
  40. the copyright on the source, documentation and executable (uh... not so
  41. sure this can be done).
  42.  
  43.   Clearly, that means that you are free (and welcomed) to give the whole
  44. distribution to anyone you want, provided
  45.  
  46. * You don't earn any money doing so
  47. * You don't modify any of the files in the distribution without a prior
  48.   consent from me
  49.  
  50. If you like this program, feel free to send me a few bucks ($5 will make
  51. me happy, but I also accept golden bars, diamonds, good jokes, cans of
  52. beers, attractive young girls, etc...). This will convince me to put you
  53. on the list of registered users...
  54.  
  55.   And now, on to more interesting things.
  56.  
  57.  
  58.       TO MAKE IT WORK...
  59.       ------------------
  60.  
  61. ccd needs Amigados 2.1 or higher (or Amigados 2.0 + amigaguide.library 34+).
  62.  
  63. It is very easy to install.
  64.  
  65. 1) put the ccd command in your C: (or BIN:, or whatever you prefer) directory
  66.    and the c.rexx file in your REXX: directory (if you have WShell)
  67.  
  68. 2) assign CCD: to the directory you would like the config file to go (see
  69.    below for further explanations about this file); I suggest you choose s:
  70.  
  71. 3) run 'ccd CREATE dh0: dh1: dh2:' for example, if you often cd into these
  72.    directories (or subdirectories of theirs). This will create the
  73.    configuration file
  74.  
  75. 4) et voila!
  76.  
  77.  
  78.  
  79.       SYNTAX
  80.       ------
  81.  
  82. This is the usual AmigaDOS notation:
  83.   /S means the option is a switch (default is : the option is not
  84.      set).
  85.   /K means the keyword must figure on the command line followed by its
  86.      value (e.g. 'ccd CF=s:.ccdconfig' or 'ccd CF s:.ccdconfig')
  87.   /M means the rest of the line
  88. An '=' sign points out a possible abbreviation for the option.
  89.  
  90. By default, ccd will try to change directly to the directory given. It fully
  91. emulates the original cd behavior from this point of view (well... not quite,
  92. see BUGS).
  93.  
  94.  
  95. CONFIGFILE/K (synonym : -cf) (default s:.ccdconfig) (v3.1)
  96.       Specify the CONFIGFILE. This is the file ccd will write that will
  97.       contain all the directories below the ones you specify at creation.
  98.  
  99.  
  100. ANTICONFIGFILE/K (synonym : -acf) (default s:.ccdanticonfig) (v3.1)
  101.       Specify the anti configuration file. This file must be created by you
  102.       and will contain a list of directories which mustn't be searched
  103.       (if you specify DH0:Fonts, this directory and all the ones below
  104.       will not be examined for a possible cd).
  105.  
  106.       NOTE : the directories won't be *searched* but they will be included
  107.       in CONFIGFILE anyway. An example ANTICONFIGFILE is included under the
  108.       name AntiConfigFileSample
  109.  
  110.  
  111. CREATE/S (synonym : -c)
  112.       Create a new CONFIGFILE file with the specified dirs
  113.  
  114.       Examples:
  115.           ccd CREATE DH0: DH1:
  116.           ccd -c env:
  117.  
  118.  
  119. UPDATE/S (synonym : -u)
  120.       Append the specified dirs to CONFIGFILE
  121.  
  122.       Examples:
  123.           ccd UPDATE T:
  124.           ccd -u t:
  125.  
  126.  
  127. NOEXPAND/S (synonym : -n)
  128.       Don't expand the directories to full paths (i.e. T: will appear as is
  129.       in CONFIGFILE, it would have been replace with RAM:T otherwise)
  130.  
  131.  
  132. SHOWAMBIGUITIES/S <n> (synonym -s)
  133.       Display all the ambiguities for a given partial dir.
  134.       If you specify a number, ccd will change to the nth occurence
  135.       of this partial directory.
  136.  
  137.       Examples :
  138.           (0).3:51PM> ccd -s lib 
  139.           dh0:lattice/lib 
  140.           dh1:DP/netdcc/include/lib
  141.           dh1:DP/gcc/lib 
  142.           dh1:uucp1/lib
  143.  
  144.       If I want to cd to dh1:DP/gcc/lib, I just have to type
  145.  
  146.           (0).4:01PM> ccd -s lib 3 
  147.           Current directory now dh1:DP/gcc/lib
  148.  
  149.       NOTE: depending whether the <n> argument is present, this option will behave
  150.       differently. If it is not present, it will display the ambiguities
  151.       without changing the directory. If it is present (and valid), ccd *will*
  152.       change to the directory.
  153.  
  154.  
  155. GUI/S (synonym : -g)
  156.       Display a graphical tree (using the Amigaguide library) where you can
  157.       click a directory to change to it.
  158.  
  159.  
  160. VERBOSE/S (synonym : -v) (v3.1)
  161.       ccd will display the new directory
  162.  
  163.       Examples : 
  164.           (0).4:01PM> ccd verbose showambiguities lib 3 
  165.           Current directory now dh1:DP/gcc/lib
  166.  
  167.  
  168.       (v3.1) Some options can be mixed :
  169.           (0).3:51PM> ccd gui showambiguities font
  170.  
  171.       will display all the ambiguities for 'font' in the graphical display. In
  172.       that case, the full paths will be displayed (this is necessary since
  173.       they may be scattered among different volumes and showing them indented
  174.       won't help you guess what volume a directory is on...).
  175.  
  176.  
  177.  
  178.      REMARKS ABOUT THE SHOWAMBIGUITIES OPTION
  179.      ----------------------------------------
  180.  
  181.   I confess this option may be a bit cumbersome to use, but
  182. nevertheless, it might be shorter than typing the whole path anyway.
  183. The second way can also be used to make this task lighter: in case of
  184. ambiguities, you will probably notice that you cd to one directory
  185. more often than the others. So, since ccd changes to the first one it
  186. finds in the config file, you could use this feature and edit the
  187. CONFIGFILE to put this directory before the other ones.
  188.  
  189.   One other problem you might face is that ccd can't find a directory
  190. whereas you know it exists. The solution is, of course, that this
  191. directory was created after you built the configuration file (the same
  192. goes for deletion of directories as well). When this happens, all you
  193. have to do is re-run 'ccd UPDATE <dirs>' in order to update this file. If
  194. your hard disk is very slow and you know it's gonna take some time,
  195. you can add the new directory manually in the file as well (on my
  196. Quantum HD, updating the file for about 30M of directories takes less
  197. than 30 secs...).
  198.  
  199.  
  200.      CCD AND WSHELL
  201.      --------------
  202.  
  203. Due to the internal nature of the way WShell updates its prompt, it is not
  204. possible for ccd to change this prompt (this has been confirmed by
  205. Mr. Hawes himself). Therefore, I supply a "wrapper" to the ccd command that
  206. will take care of this.
  207.  
  208. If you are using WShell, don't use "ccd", use "c". This is the same command
  209. except that it will update WShell's prompt properly. "c" is a very short Arexx
  210. script that you should put in your REXX: directory.
  211.  
  212.  
  213.      SOMETHING DOESN'T WORK?
  214.      -----------------------
  215.  
  216. If ccd seems not to work properly, this may be because of the indermediate
  217. files it is using. In that case, type
  218.  
  219. delete t:#?ccd#?
  220.  
  221. and try again.
  222.  
  223.  
  224.  
  225.      FILES USED BY CCD
  226.      -----------------
  227.  
  228. ccd:.ccdconfig (CONFIGFILE)    This file gathers all the directories
  229. env:ccd/LAST_DIR        Used by the GUI to store the directory selected
  230. t:ccd.guide            Amigaguide version of CONFIGFILE
  231. t:ccdChangeDir.rexx             ARexx script generated for the GUI
  232.  
  233.  
  234.  
  235.      FILES FOR THE USER
  236.      ------------------
  237.  
  238. ccd                THE command :-)
  239. c.rexx                Wrapper for ccd and WShell
  240. ccd:.ccdanticonfig        List of directories never to cd to
  241.  
  242.  
  243.  
  244.  
  245.      BUGS
  246.      ----
  247.  
  248. . ccd will not update the Titlebar with WShell. I still haven't found the
  249. proper way to do this and since WShell's cd is builtin, I can't even
  250. disassemble it...
  251.  
  252.  
  253.  
  254.       THANKS
  255.       ------
  256.  
  257.  
  258.  
  259. -->  Walter Francis,
  260.                    for suggesting the anti config-file and pointing out
  261.                    some bugs
  262.  
  263. -->  Jean-Charles Godien,
  264.                    for coming up with bright ideas
  265.  
  266. -->  Cedric NEROT,
  267.                    aka Sr, aka Cedric the 2nd,
  268.                    it was an idea of his, and since he's taller and
  269.                    stronger than me, I have to give his name. In
  270.                    retaliation, I hid a virus in his version (snigger,
  271.                    snigger). And he will never read the doc, anyway.
  272.  
  273. --> Pierre ARDICHVILI,
  274.                    for numerous advice, mainly regarding PAL/NTSC detection
  275.                    and better '-u' handling.
  276.  
  277. --> David MOLINIER,
  278.                    for beta-testing and pointing out a few bugs to me.
  279.  
  280. -->  Matt DILLON,
  281.                    for providing us with such a neat compiler! And for the
  282.                    help along the way... And for uucp. And for dmouse. And
  283.                    for the Cosby Show. And for the electric tooth brush.
  284.                    And for the space shuttle. And for... ouch! [sacked by
  285.                    audience]
  286.  
  287. -->  abcd!Leon,
  288.                    for pointing out to me the 'ccd /' bug that was fixed
  289.                    on from the version 1.4 (sorry, Leon, my mails to you
  290.                    bounced each time I tried, so I don't know more from
  291.                    you...)
  292.  
  293.  
  294. ---    Cedric BEUST
  295. ---    Nice, $Date: 1993/07/04 13:40:46 $
  296.